Adding log to print all configuration flags at start of gcs fuse mount #1565

ankitaluthra1 · 2023-12-27T05:20:06Z

Description

Uses flagStorage struct to get all flags which are being used in gcsfuse and add a info log while starting gcsfuse

Link to the issue in case of a bug fix.

issue-link

Testing details

Manual - Done on Local
Unit tests - Added unit test for logic of aggregated log message containing all flags
Integration tests - NA

raj-prince · 2023-12-27T05:33:25Z

In this PR, we are only logging passed flags, right? We also need to print the config flags.
Could you please update the PR description with the newly added logs?
Lint is failing.

…d struct

ankitaluthra1 · 2023-12-27T13:47:06Z

text format log is attached

Sample log in json format is as follows (For now I have kept "" in the log as I am not sure removing " from logs will result in any formatting errors for any customers, let me know if we need to remove "" from log statement)
{"time":{"timestampSeconds":1703683455,"timestampNanos":1703683455611934894},"severity":"INFO","msg":"Loading config for mount flags {\"AppName\":\"\",\"Foreground\":true,\"ConfigFile\":\"\",\"MountOptions\":{},\"DirMode\":493,\"FileMode\":420,\"Uid\":-1,\"Gid\":-1,\"ImplicitDirs\":false,\"OnlyDir\":\"\",\"RenameDirLimit\":0,\"CustomEndpoint\":null,\"BillingProject\":\"\",\"KeyFile\":\"\",\"TokenUrl\":\"\",\"ReuseTokenFromUrl\":true,\"EgressBandwidthLimitBytesPerSecond\":-1,\"OpRateLimitHz\":-1,\"SequentialReadSizeMb\":200,\"MaxRetrySleep\":30000000000,\"StatCacheCapacity\":4096,\"StatCacheTTL\":60000000000,\"TypeCacheTTL\":60000000000,\"HttpClientTimeout\":0,\"MaxRetryDuration\":-1000000000,\"RetryMultiplier\":2,\"LocalFileCache\":false,\"TempDir\":\"\",\"ClientProtocol\":\"http1\",\"MaxConnsPerHost\":100,\"MaxIdleConnsPerHost\":100,\"EnableNonexistentTypeCache\":false,\"StackdriverExportInterval\":0,\"OtelCollectorAddress\":\"\",\"LogFile\":\"\",\"LogFormat\":\"json\",\"ExperimentalEnableJsonRead\":false,\"DebugFuseErrors\":true,\"DebugFuse\":false,\"DebugFS\":false,\"DebugGCS\":false,\"DebugHTTP\":false,\"DebugInvariants\":false,\"DebugMutex\":false}"} {"time":{"timestampSeconds":1703683455,"timestampNanos":1703683455611975904},"severity":"INFO","msg":"Loading config from config-file {\"CreateEmptyFile\":false,\"Severity\":\"INFO\",\"Format\":\"json\",\"FilePath\":\"\",\"LogRotateConfig\":{\"MaxFileSizeMB\":512,\"BackupFileCount\":10,\"Compress\":true}}"}

ankitaluthra1 · 2023-12-27T13:49:24Z

In this PR, we are only logging passed flags, right? We also need to print the config flags.

Could you please update the PR description with the newly added logs?

Lint is failing.

Added config file flags as well
Added sample logs in comment
Lint is fixed

main.go

main_test.go

main.go

… test

main_test.go

raj-prince

Few minor comments.

…alErrorsOut

internal/util/util_test.go

internal/util/util.go

internal/util/util_test.go

raj-prince

LGTM, Added few nits.

internal/util/util.go

raj-prince

LGTM, minor doc change.

#1565) * logs flags while mounting gcsfuse * updates log message for mount flag * fixes import lint issue * refactors and renames toString method to support marshalling of nested struct * refactor stringify to use json marshal * adds method for error handling in stringify * updates logger message for flags | remove unnecessary trim space from test * changes stringify error log to warn log * makes customType private * removes extra line from TestStringifyShouldReturnEmptyStringWhenMarshalErrorsOut * moves Stringify to util package * adds doc for Stringify * removes unnecessary TrimSpace * updates Stringify docs to Go format

…se mount (#1565)

#1565) * logs flags while mounting gcsfuse * updates log message for mount flag * fixes import lint issue * refactors and renames toString method to support marshalling of nested struct * refactor stringify to use json marshal * adds method for error handling in stringify * updates logger message for flags | remove unnecessary trim space from test * changes stringify error log to warn log * makes customType private * removes extra line from TestStringifyShouldReturnEmptyStringWhenMarshalErrorsOut * moves Stringify to util package * adds doc for Stringify * removes unnecessary TrimSpace * updates Stringify docs to Go format

ankitaluthra1 added 2 commits December 26, 2023 14:05

logs flags while mounting gcsfuse

b547eb0

updates log message for mount flag

0d6fcb4

ankitaluthra1 requested review from sethiay, vadlakondaswetha and raj-prince as code owners December 27, 2023 05:20

ankitaluthra1 added 4 commits December 27, 2023 06:34

fixes import lint issue

9184ec0

refactors and renames toString method to support marshalling of neste…

9428844

…d struct

refactor stringify to use json marshal

54d5c98

adds method for error handling in stringify

62a9e30